1 /*
2  * Copyright (c) 2011-2012 - Mauro Carvalho Chehab
3  * Copyright (c) 2012 - Andre Roth <neolynx@gmail.com>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published by
7  * the Free Software Foundation version 2.1 of the License.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  * Or, point your browser to http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
18  *
19  */
20 
21 /**
22  * @file desc_hierarchy.h
23  * @ingroup descriptors
24  * @brief Provides the descriptors for the hierarchy descriptor
25  * @copyright GNU Lesser General Public License version 2.1 (LGPLv2.1)
26  * @author Mauro Carvalho Chehab
27  * @author Andre Roth
28  *
29  * @par Relevant specs
30  * The descriptor described herein is defined at:
31  * - ISO/IEC 13818-1
32  *
33  * @see
34  *
35  * @par Bug Report
36  * Please submit bug reports and patches to linux-media@vger.kernel.org
37  */
38 
39 module libdvbv5_d.desc_hierarchy;
40 
41 import libdvbv5_d.descriptors: dvb_desc;
42 import libdvbv5_d.dvb_fe: dvb_v5_fe_parms;
43 
44 extern (C):
45 
46 /**
47  * @struct dvb_desc_hierarchy
48  * @ingroup descriptors
49  * @brief Structure containing the hierarchy descriptor
50  *
51  * @param type			descriptor tag
52  * @param length		descriptor length
53  * @param next			pointer to struct dvb_desc
54  * @param hierarchy_type	hierarchy type
55  * @param layer			hierarchy layer index
56  * @param embedded_layer	hierarchy embedded layer  index
57  * @param channel		hierarchy channel
58  */
59 struct dvb_desc_hierarchy
60 {
61     import std.bitmanip : bitfields;
62     align (1):
63 
64     ubyte type;
65     ubyte length;
66     dvb_desc* next;
67 
68     mixin(bitfields!(
69         ubyte, "hierarchy_type", 4,
70         ubyte, "reserved", 4,
71         ubyte, "layer", 6,
72         ubyte, "reserved2", 2,
73         ubyte, "embedded_layer", 6,
74         ubyte, "reserved3", 2,
75         ubyte, "channel", 6,
76         ubyte, "reserved4", 2));
77 }
78 
79 // struct dvb_v5_fe_parms;
80 
81 /**
82  * @brief Initializes and parses the hierarchy descriptor
83  * @ingroup descriptors
84  *
85  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
86  * @param buf	buffer containing the descriptor's raw data
87  * @param desc	pointer to struct dvb_desc to be allocated and filled
88  *
89  * This function initializes and makes sure that all fields will follow the CPU
90  * endianness. Due to that, the content of the buffer may change.
91  *
92  * Currently, no memory is allocated internally.
93  *
94  * @return On success, it returns the size of the allocated struct.
95  *	   A negative value indicates an error.
96  */
97 int dvb_desc_hierarchy_init (
98     dvb_v5_fe_parms* parms,
99     const(ubyte)* buf,
100     dvb_desc* desc);
101 
102 /**
103  * @brief Prints the content of the hierarchy descriptor
104  * @ingroup descriptors
105  *
106  * @param parms	struct dvb_v5_fe_parms pointer to the opened device
107  * @param desc	pointer to struct dvb_desc
108  */
109 void dvb_desc_hierarchy_print (dvb_v5_fe_parms* parms, const(dvb_desc)* desc);